• Jump To … +
    main.js separate.js single.js web-apg-api.js main.js web-conv-api.js ast.js csv.js dangling-else.js display.js flags.js float.js limits.js main.js multiline-mode.js recursive.js replace.js rules.js split.js testonly.js trace.js udt.js unicode.js web-email.js word-boundaries.js main.js phone-number.js web-main.js web-phone-number.js main.js phone-number.js setup.js translate.js xml.js branch-fail-grammar.js main.js parent-mode-grammar.js setup.js universal-mode-grammar.js colors-app.js colors-callbacks.js colors.js main.js more-app.js more-setup.js more.js ast-callbacks.js bad-input.js basic.js ini-file.js main.js parser-callbacks.js setup.js trace.js anbncn.js and.js c-comment.js compound.js main.js nested.js not.js setup.js boundaries-grammar.js boundaries.js comment-grammar.js comment.js main.js negative-grammar.js negative.js positive-grammar.js positive.js setup.js main.js odata-grammar.js run.js setup.js area-code.js lookaround.js main.js phone-number.js setup.js simple.js all-operators.js default.js fancy-number.js limited-lines.js main.js select-operators.js select-rules.js setup.js main.js minimal.js parent-u.js parent.js phone-number.js setup.js stats.js trace.js universal-u.js universal.js callbacks.js grammar.js main.js parser.js writeHtml.js LICENSE.md README.md index.md
  • parser.js

  • §
    /* eslint-disable new-cap */
    /* eslint-disable guard-for-in */
    /* eslint-disable no-restricted-syntax */
    /*  *************************************************************************************
     *   copyright: Copyright (c) 2025 Lowell D. Thomas, all rights reserved
     *     license: BSD-2-Clause (https://opensource.org/licenses/BSD-2-Clause)
     *   ********************************************************************************* */
  • §

    This module illustrates a complete and well-tested URI parser.

    module.exports = function parser(input) {
  • §

    If trace or statistics are needed they are available but must be enabled here manually.

      const TRACE_ENABLED = false;
      const STATS_ENABLED = false;
      const THIS_FILE = 'parser.js: ';
  • §

    Initialize parser and grammar.

      const { apgLib } = require('apg-js');
      const parser = new apgLib.parser();
      const grammar = new (require('./grammar'))();
    
      if (TRACE_ENABLED) {
        parser.trace = new apgLib.trace();
        parser.trace.filter.operators['<ALL>'] = true;
      }
      if (STATS_ENABLED) parser.stats = new apgLib.stats();
  • §

    Register callbacks.

      const cb = require('./callbacks');
      Object.assign(parser.callbacks, {
        URI: cb.URI,
        scheme: cb.scheme,
        'userinfo-at': cb.userinfoAt,
        host: cb.host,
        'IP-literal': cb.ipLiteral,
        port: cb.port,
        'path-abempty': cb.pathAbempty,
        'path-absolute': cb.pathAbsolute,
        'path-rootless': cb.pathRootless,
        'path-empty': cb.pathEmpty,
        query: cb.query,
        fragment: cb.fragment,
        IPv4address: cb.ipv4,
        h16: cb.h16,
        h16c: cb.h16,
        h16n: cb.h16,
        h16cn: cb.h16,
        nodcolon: cb.nodcolon,
        dcolon: cb.dcolon,
        'dec-octet': cb.decOctet,
        'dec-digit': cb.decDigit,
      });
  • §

    Data object for parse state and URI elements.

      const data = { uriElements: {} };
  • §

    Parse the input URI string.

      const result = parser.parse(grammar, 0, input, data);
    
      if (parser.stats) {
        const writeHtml = require('../writeHtml');
        const html = parser.stats.toHtmlPage('hits', 'rules ordered by hit count', 'URI parser Stats');
        writeHtml(html, 'uri-stats');
      }
      if (parser.trace) {
        const writeHtml = require('../writeHtml');
        const html = parser.trace.toHtmlPage('ascii', 'IniFile Trace', 'URI parser Trace');
        writeHtml(html, 'uri-trace');
      }
    
      if (!result.success) {
        throw new Error(`${THIS_FILE}parse failed: ${JSON.stringify(result)}`);
      }
  • §

    Return the parsed URI elements as an object.

      return data.uriElements;
    };